Doc generator - #126
Conversation
|
Demitrius Nelon (@denelon) Curious to your thoughts. |
|
I'd like Ryan (@ryfu-msft) to take a look. I think the idea is sound, I just want to make sure we're not departing too far away from making it easy to add new resources and subsequently have the ability to move them to their own new "home". For the Microsoft modules they might stay here or move to another repository, and for the non-Microsoft resources, we might want them to move to either the DSC Community or to live with the product they configure. |
7b7f855 to
db2ac3a
Compare
db2ac3a to
d23e3d2
Compare
|
This feels like it should be part of a GitHub Action or other automated pipeline step. |
Ideally, it would be a good addition to have it added to the pipeline. Whenever new users either introduce a new module or make changes to the current ones, it would be beneficial to check the documentation and see if it requires changes. It should also help users who contribute to easily run the necessary functions to generate it, keeping standardization in the docs. |
d23e3d2 to
7100516
Compare
3 participants
This pull request addresses an initial setup to start generating documentation for all classes. The end goal of the doc generator:
Note
The static methods came from the idea on the DSC discussion by Mikey. This is far from crystalized, but an attempt to kickstart the idea for resource authors in this repository.
I talked with Jim Truher also on class documentation, but there isn't anything available (yet). In the current commit, you can also see the attempt to dynamically generate docs using the
Microsoft.PowerShell.PlatyPSmodule. However, there are to many properties outputted when converting for Markdown. That's why I choose the way to build it up using separate functions.Microsoft Reviewers: Open in CodeFlow